Skip to main content
POST
/
api
/
v3
/
products
Create a product [V3]
curl --request POST \
  --url https://api.loops.fi/api/v3/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "active": true,
  "images": [
    "<string>"
  ],
  "metadata": {},
  "package_dimensions": {
    "height": 123,
    "length": 123,
    "weight": 123,
    "width": 123
  },
  "shippable": true,
  "statement_descriptor": "<string>",
  "tax_code": "<string>",
  "unit_label": "<string>",
  "url": "<string>",
  "thumbnailUrl": "<string>",
  "amountType": "FIXED",
  "priceAmount": 1.5,
  "minimumAmount": 1.5,
  "presetAmount": 123,
  "recurringInterval": "month",
  "priceCurrency": "USD"
}'
{
  "id": "<string>",
  "object": "product",
  "active": true,
  "created": 123,
  "default_price": "<string>",
  "description": "<string>",
  "images": [
    "<string>"
  ],
  "livemode": true,
  "metadata": {},
  "name": "<string>",
  "package_dimensions": {
    "height": 123,
    "length": 123,
    "weight": 123,
    "width": 123
  },
  "shippable": true,
  "statement_descriptor": "<string>",
  "tax_code": "<string>",
  "type": "good",
  "unit_label": "<string>",
  "updated": 123,
  "url": "<string>",
  "thumbnailUrl": "<string>",
  "recurringInterval": "month",
  "amountType": "FIXED",
  "priceAmount": "<string>",
  "minimumAmount": "<string>",
  "presetAmount": "<string>",
  "priceCurrency": "<string>",
  "status": "ACTIVE",
  "merchantId": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key authentication using Bearer token

Body

application/json
​
name
string
required

The product's name, meant to be displayable to the customer

Minimum length: 1
​
description
string

The product's description, meant to be displayable to the customer

​
active
boolean
default:true

Whether the product is currently available for purchase

​
images
string<uri>[]

A list of up to 8 URLs of images for this product

​
metadata
object

Set of key-value pairs that you can attach to an object

​
package_dimensions
object
​
shippable
boolean

Whether this product is shipped

​
statement_descriptor
string

Extra information about a product which will appear on your customer's credit card statement

Maximum length: 22
​
tax_code
string

A tax code ID

​
unit_label
string

A label that represents units of this product

​
url
string<uri>

A URL of a publicly-accessible webpage for this product

​
thumbnailUrl
string<uri>

Product thumbnail image URL (Loops-specific)

​
amountType
enum<string>
default:FIXED

Amount type (Loops-specific)

Available options:
FIXED,
CUSTOM,
FREE
​
priceAmount
number

Price amount (Loops-specific)

Required range: x >= 0.5
​
minimumAmount
number

Minimum amount (Loops-specific)

Required range: x >= 0.5
​
presetAmount
number

Preset amount (Loops-specific)

Required range: x <= 10000
​
recurringInterval
enum<string>

Recurring interval for subscriptions (Loops-specific)

Available options:
month,
year
​
priceCurrency
string
default:USD

Price currency (Loops-specific)

Response

Default Response

​
id
string
required

Unique identifier for the object

​
object
enum<string>
required

String representing the object's type

Available options:
product
​
active
boolean
required

Whether the product is currently available for purchase

​
created
integer
required

Time at which the object was created

​
livemode
boolean
required

Has the value true if the object exists in live mode or the value false if the object exists in test mode

​
name
string
required

The product's name, meant to be displayable to the customer

​
type
enum<string>
required

The type of the product

Available options:
good,
service
​
updated
integer
required

Time at which the object was last updated

​
default_price
string | null

The ID of the price object

​
description
string | null

The product's description, meant to be displayable to the customer

​
images
string<uri>[]

A list of up to 8 URLs of images for this product

​
metadata
object

Set of key-value pairs that you can attach to an object

​
package_dimensions
object
​
shippable
boolean | null

Whether this product is shipped

​
statement_descriptor
string | null

Extra information about a product which will appear on your customer's credit card statement

​
tax_code
string | null

A tax code ID

​
unit_label
string | null

A label that represents units of this product

​
url
string<uri> | null

A URL of a publicly-accessible webpage for this product

​
thumbnailUrl
string<uri> | null

Product thumbnail image URL (Loops-specific)

​
recurringInterval
enum<string> | null

Recurring interval for subscriptions (Loops-specific)

Available options:
month,
year
​
amountType
enum<string>

Amount type (Loops-specific)

Available options:
FIXED,
CUSTOM,
FREE
​
priceAmount
string | null

Price amount as string (Loops-specific)

​
minimumAmount
string | null

Minimum amount as string (Loops-specific)

​
presetAmount
string | null

Preset amount as string (Loops-specific)

​
priceCurrency
string

Price currency (Loops-specific)

​
status
enum<string>

Product status (Loops-specific)

Available options:
ACTIVE,
DRAFT,
INACTIVE
​
merchantId
string

Merchant ID (Loops-specific)

⌘I